Updater Command Usage

The application basically interfaces with the Updater to peform software update. However, you can also run the Updater individually without interfacing with the application. Through the Updater command, you can configure the Updater settings, set up to load the Updater at startup, allow the user to run the Updater manually, etc.

The following is the Updater command usage.

Usage: UPDSHL10 <Updater ID> <Startup Flag> <Update Type> <Interval> <User ID> <Force to Terminate> <Key Location>

Where

Updater ID: The Updater ID is provided in UpdateShield Builder, under the Status tab.

Startup Flag: Updater startup options

0 = Run the Updater until the application is closed

1 = Run the Updater without termination

2 = Run the Updater and install the agent to the Windows startup

3 = Delete the Updater from the Windows startup

4 = Install the Updater to the Windows startup

Update Type: Type of check for updates

0 = N/A

1 = General: Update by loading the Server Side index file

2 = Subscription: Update by connecting to the Update Server

3 = Reserved

4 = Admin: Update for the local update server, by connecting to the software update server

Interval: The interval time to check for updates

0 = None

1 up to 2147483647 = The time interval in seconds

-2 = Check for updates immediately and show the Updater dialog box

User ID: The User ID to connect to the Update Server

0 = Not used

-1 = Generate the User ID randomly (for clients to connect to the local update server)

-2 = Find the User ID from the Local Key (for the application protected and licensed by ElecKey)

-3 = Find the User ID from the Network Key (for the admin Updater, which the local update server also hosts the NetKey License Server)

1 up to 2147483647 = Specifically assign the User ID to the Updater

Force to Terminate: Indicate whether the Updater terminates the application before executing the update (use with the UpdateCheck API)

0 = Disabled

1 = Enabled

Key Location: The location of the Key (when the Updater finds the User ID from the Local or Network Key created by the ElecKey system)

0 = The Key in the All Users profile folder

1 = The Key in the drive C:

2 = The Key in the drive D:

3 = The Key in the drive E:

30 = The Key in a USB drive

Examples

To run the Updater and install the Updater to the Windows startup:

UPDSHL10 0100B03FD1305A4B 2

To delete the Updater from the Windows startup:

UPDSHL10 0100B03FD1305A4B 3

To run the Updater as the general type to check for updates:

UPDSHL10 0100B03FD1305A4B 0 1

To run the Updater as the general type to check for updates, every one hour:

UPDSHL10 0100B03FD1305A4B 0 1 3600

To run the Updater as the subscription type with the User ID 1234567890:

UPDSHL10 0100B03FD1305A4B 0 2 0 1234567890

To run the Updater as the subscription type with the User ID from the Key:

UPDSHL10 0100B03FD1305A4B 0 2 0 -2

To run the Updater as the subscription type with the randomly generated User ID:

UPDSHL10 0100B03FD1305A4B 0 2 0 -1

To run the Updater as the admin type with the User ID from the Network Key, and to check for updates every one hour:

UPDSHL10 0100B03FD1305A4B 0 4 3600 -3

The Updater command should be run before running the protected application, or it can also be included in the application installer.

NOTE: Instead of using the Updater command, you can install the Updater to the Windows startup by editing the Windows registry and creating a new key in HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\Current Version\Run. The key name should be the Updater ID. For example, 0100B03FD1305A4B. The value is the full path of the Updater, plus the Updater ID and the startup flag 1. For example, “C:\Program Files\ABC Software\updshl10.exe” 0100B03FD1305A4B 1.

See Also

· UpdateShield System Files

· Index Files

· Setup Script for the Updater

· Customizing the Updater UI

· Interfacing with ElecKey